/*
 * Copyright (c) 2002-2020 Manorrock.com. All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *   3. Neither the name of the copyright holder nor the names of its
 *      contributors may be used to endorse or promote products derived from
 *      this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package cloud.piranha.webapp.api;

/**
 * The web application extension context API.
 *
 * @author Manfred Riem (mriem@manorrock.com)
 */
public interface WebApplicationExtensionContext {

    /**
     * Add the extension to the web application.
     *
     * <p>
     * This will add this extension to the list of extensions that will be used
     * when configuring the web application.
     * </p>
     *
     * @param extension the extension.
     */
    void add(Class<? extends WebApplicationExtension> extension);

    /**
     * Add the extension to the web application.
     *
     * <p>
     * This will add this extension to the list of extensions that will be used
     * when configuring the web application.
     * </p>
     *
     * @param extension the extension.
     */
    void add(WebApplicationExtension extension);

    /**
     * Remove the extension from the web application.
     *
     * <p>
     * This will remove the extension from the list of extensions that will be
     * used when configuring the web application.
     * </p>
     * <p>
     * NOTE this will ONLY remove this extension. Any extensions that were added
     * to the list by this extension BEFORE it was removed will NOT be removed
     * from the list of extensions. This is by design.
     * </p>
     *
     * @param extension the extension.
     */
    void remove(Class<? extends WebApplicationExtension> extension);
}
